/*! \file rm_alpm.h
 *
 * Main routines for RM ALPM
 *
 * This file contains main routines which are internal to
 * ALPM resource manager
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef RM_ALPM_H
#define RM_ALPM_H

/*******************************************************************************
  Includes
 */

#include <shr/shr_error.h>
#include <shr/shr_debug.h>
#include <shr/shr_dq.h>
#include <bcmptm/bcmptm.h>
#include <bcmptm/bcmptm_internal.h>
#include <bcmptm/bcmptm_rm_alpm_internal.h>

#include "rm_alpm_common.h"
#include "rm_alpm_trie.h"
#include "rm_alpm_trie_util.h"

/*******************************************************************************
  Defines
 */

#define SHR_RETURN      SHR_RETURN_VAL_EXIT

/*******************************************************************************
  Typedefs
 */

/*!
 * \brief ALPM controls for interacting with comdproc
 */
typedef struct alpm_cmd_ctrl_s {
    bool            write_hw;               /*!< Write to HW */
    bool            write_cache;            /*!< Write to cache */
    bool            set_cache_vbit;         /*!< Set Cache vbit */
    bcmltd_sid_t    req_ltid;               /*!< Request ltid */
    uint16_t        req_format_id;          /*!< Request format id */
    uint32_t        req_flags;              /*!< Request flags */
    bool            rsp_entry_cache_vbit;   /*!< Responsed vbit */
    bcmltd_sid_t    rsp_ltid;               /*!< Responsed ltid */
    uint16_t        rsp_dfield_format_id;   /*!< Responsed format id */
    uint32_t        rsp_flags;              /*!< Responsed flags */
    int             inst;                   /*!< Table instance */
    uint32_t        cseq_id;                /*!< Cseq Id */
} alpm_cmd_ctrl_t;

/*!
 * \brief ALPM control for debug purpose
 */
typedef union alpm_dbg_ctrl_s {
    struct {
        uint32_t pivot_sanity : 1;
        uint32_t pivot_sanity_len : 1;
        uint32_t pivot_defrag : 1;
        uint32_t pivot_sanity_node : 1;
        uint32_t pivot_sanity_count : 1;
        uint32_t pivot_cache_only : 1;
        uint32_t pivot_bank_conf : 1;
        uint32_t hitbit: 1;
    } f;
    uint32_t entry;
} alpm_dbg_ctrl_t;

/*!
 * \brief ALPM info, the top structure contains everything describing ALPM
 */
typedef struct alpm_info_s {
    /*!< Comproc controls */
    alpm_cmd_ctrl_t cmd_ctrl;

    /*!< ALPM Configurations */
    alpm_config_t config;

    /*!< Entry size for LT-mapped PT */
    uint8_t mapped_pt_words[IP_VERS];

    /*!< ALPM controls for debug purpose */
    alpm_dbg_ctrl_t alpm_dbg_ctrl;
} alpm_info_t;

/*******************************************************************************
  Function prototypes
 */
/*!
 * \brief Check if urpf enabled
 *
 * \param [in] u Device u.
 *
 * \return True/False
 */
extern int
bcmptm_rm_alpm_is_urpf(int u);

/*!
 * \brief ALPM mode
 *
 * \param [in] u Device u.
 *
 * \return Combined/Parallel
 */
extern int
bcmptm_rm_alpm_mode(int u);

/*!
 * \brief Is packing mode 128 set
 *
 * \param [in] u Device u.
 *
 * \return True or false
 */
extern bool
bcmptm_rm_alpm_pkm128_is_set(int u);

extern uint8_t
bcmptm_rm_alpm_uft_banks(int u, int ln);

/*!
 * \brief Get ALPM info
 *
 * \param [in] u Device u.
 *
 * \return ALPM info ptr
 */
extern alpm_info_t *
bcmptm_rm_alpm_info_get(int u);


/*!
 * \brief Insert entry into ALPM database
 *
 * \param [in] u Device u.
 * \param [in] arg ALPM args
 * \param [in] levels ALPM levels
 *
 * \return SHR_E_XXX
 */
extern int
bcmptm_rm_alpm_insert(int u, alpm_arg_t *arg, int levels);

/*!
 * \brief Exact match entry in ALPM database
 *
 * \param [in] u Device u.
 * \param [in] arg ALPM args
 * \param [in] levels ALPM levels
 *
 * \return SHR_E_XXX
 */
extern int
bcmptm_rm_alpm_match(int u, alpm_arg_t *arg, int levels);

/*!
 * \brief Delete entry from ALPM database
 *
 * \param [in] u Device u.
 * \param [in] arg ALPM args
 * \param [in] levels ALPM levels
 *
 * \return SHR_E_XXX
 */
extern int
bcmptm_rm_alpm_delete(int u, alpm_arg_t *arg, int levels);

/*!
 * \brief LPM find entry in ALPM database
 *
 * \param [in] u Device u.
 * \param [in] arg ALPM args
 * \param [in] levels ALPM levels
 *
 * \return SHR_E_XXX
 */
extern int
bcmptm_rm_alpm_find(int u, alpm_arg_t *arg, int levels);

/*!
 * \brief Abort current transaction for RM ALPM
 *
 * \param [in] u Device u.
 * \param [in] full True if full abort, otherwise partial abort.
 *
 * \return SHR_E_XXX
 */
extern int
bcmptm_rm_alpm_abort(int u, bool full);

/*!
 * \brief Commibt current transaction for RM ALPM
 *
 * \param [in] u Device u.
 *
 * \return SHR_E_XXX
 */
extern int
bcmptm_rm_alpm_commit(int u);

#endif /* RM_ALPM_H */
